Skip to content

Add CLI/SDK/API reference docs#99

Open
guthrie-vast wants to merge 8 commits intomainfrom
api-cli-sdk-pages-update-clean
Open

Add CLI/SDK/API reference docs#99
guthrie-vast wants to merge 8 commits intomainfrom
api-cli-sdk-pages-update-clean

Conversation

@guthrie-vast
Copy link
Copy Markdown
Collaborator

Summary

  • Adds full CLI reference (138 command pages + get-started, auth, permissions, templates, rate-limits)
  • Adds full Python SDK reference (138 method pages + 10 serverless client pages + get-started pages)
  • Adds API reference authentication and permissions pages; warning to introduction page
  • Updates docs.json SDK/CLI/API tabs with structured navigation; leaves Documentation tab untouched
  • Removes stale cli/commands.mdx; adds 4 redirects for moved/renamed pages

Test plan

  • Mintlify preview builds without errors
  • /cli/hello-world loads; /cli/commands and /cli/get-started redirect there
  • /api-reference/permissions loads; /api-reference/permissions-and-authorization redirects there
  • SDK reference sidebar shows all groups (Get Started, VastAI Client, Methods, Serverless)
  • CLI reference sidebar shows all command groups

🤖 Generated with Claude Code

- Add full CLI reference (138 command pages + get-started, auth, permissions, templates, rate-limits)
- Add full Python SDK reference (138 method pages + serverless client docs + get-started pages)
- Add API reference authentication and permissions pages
- Add warning to API reference introduction page
- Update docs.json: replace SDK/CLI/API tabs with structured reference navigation
- Add redirects for /cli/commands, /api-reference/permissions-and-authorization
- Remove stale cli/commands.mdx (replaced by /cli/reference/)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@mintlify
Copy link
Copy Markdown
Contributor

mintlify bot commented Apr 3, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
vastai-80aa3a82 🟢 Ready View Preview Apr 3, 2026, 2:00 AM

CLI/SDK reference pages and Hello World guides now show markdown tables
explaining what each actual_status, intended_status, cur_state, and
next_state value means — not just listing the values. Also updates
openapi.json with enum+description for status fields.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
The old URL doesn't exist. Fixes Gobind's review comment across all
7 files that linked to it.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@guthrie-vast
Copy link
Copy Markdown
Collaborator Author

updated with both of these adjustments @Gobind-Vast

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For some reason, this particularly page does not load in the mintlify preview. I tried re-running mintlify dev, but it still appears without content

Image

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yikes, i removed this. please double check that it is gone. this is not released yet


## Description

Query syntax:
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This "Query syntax" description (also appears on other search pages) isn't formatted with newline characters in the rendering, so it's all jumbled together

Image

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually it seems to be a more general issue for the Description section (this is in "Instances" > "stop instances" in the CLI section:

Image

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should be fixed. formatting issue which affected description on a lot of files. can you do a spot check?

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- CLI: remove 'Other' group; deployment pages → Deployments; update-workers → Serverless; show-instances-v1 → Instances
- SDK: keep separate Deployments group (was already correct)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…e-snapshot

- Wrap query syntax grammar in fenced code blocks (was collapsing in MDX)
- Move 'Available fields' content out of bash code blocks into markdown tables
- Fix 'Examples:' leaking into ## Description as plain prose
- Dedent indented example commands inside code blocks
- Convert plain-text field lists to | Field | Type | Description | tables
- Delete take-snapshot CLI and SDK pages and remove from docs.json sidebar

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants